<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Spry Checkbox Validation API</title>
<link href="../../../css/articles.css" rel="stylesheet" type="text/css" />
</head>

<body>
<div id="accordion">
  <h3>Checkbox Validation Widget</h3>
  <h4>Description</h4>
  <p>The Spry Checkbox Validation Widget is used to validate a checkbox or series of checkboxes before submitting the form. </p>
  <h4>Required Files</h4>
  <blockquote>
    <p><a href="../../../widgets/checkboxvalidation/SpryValidationCheckbox.js">SpryValidationCheckbox.js</a></p>
    <p><a href="../../../widgets/checkboxvalidation/SpryValidationCheckbox.css">SpryValidationCheckbox.css</a></p>
  </blockquote>
  <h4>Reference File</h4>
  <blockquote>
    <p><a href="../../../widgets/checkboxvalidation/SpryValidationCheckbox.html">SpryValidationCheckbox.html</a></p>
  </blockquote>
  <h4>Sample Files</h4>
  <blockquote>
    <p><a href="../../../samples/validationwidgets/CheckboxValidationSample.html">CheckboxValidationSample.html</a></p>
  </blockquote>
  <h4>&nbsp;</h4>
</div>

<div id="structure"><h3> Structure</h3>
  <p>The widget structure is as follows:</p>
  <pre>
   &lt;widget container&gt;
      &lt;input checkbox(es)&gt;<br />      &lt;message container&gt;<br />   &lt;/widget container&gt;<br /></pre>
  <p>The Checkbox Validation Widget supports one or many checkboxes.</p>
      <p>The markup used in this structure can be most any HTML, as long as it follows the rules for nesting. </p>
      <p>Using the provided files, the default mark up is:</p>
      <pre>&lt;span id=&quot;sprycheckbox1&quot;&gt;<br />  &lt;input type=&quot;checkbox&quot; name=&quot;checkbox1&quot; id=&quot;checkbox1&quot; /&gt;<br />  &lt;span class=&quot;checkboxRequiredMsg&quot;&gt;Please make a selection.&lt;/span&gt;&lt;/span&gt;</pre>
</div>

<div id="constructor"><h3>Constructor</h3>
  <p>Widget Constructors are small pieces of javascript that activate the markup into the working widget. These scripts must come AFTER the markup on the page, since the markup needs to exist before the constructor fires.</p>
  <pre>&lt;script type=&quot;text/javascript&quot;&gt;<br />var sprycheckbox1 = new Spry.Widget.ValidationCheckbox(&quot;sprycheckbox1&quot;);<br />&lt;/script&gt;</pre>
  <h4>Basic Constructor</h4>
  <p>A basic constructor specifies the name of the widget and identifies the ID of the main markup container. The name of the widget is used to identify the widget for functions and methods.</p>
  <pre> &lt;script type=&quot;text/javascript&quot;&gt; 
   var <span class="hilite">widgetname</span> = new Spry.Widget.ValidationCheckbox(&quot;<span class="hilite">id of widget container</span>&quot;);   
&lt;/script&gt;
</pre>
  <h4>Constructor Options</h4>
  <p>Constructor options allow users to specify certain attributes of the widget.</p>
  <p>Constructor options follow the ID parameter, wrapped in curly braces {}. Options are name:value pairs, separated by a colon (:). </p>
  <pre> &lt;script type=&quot;text/javascript&quot;&gt; 
   var widgetname = new Spry.Widget.ValidationCheckbox(&quot;id of widget container&quot;<span class="hilite">,{option1:value, option2:value, option3:&quot;value&quot;}</span>);   
 &lt;/script&gt;
  </pre>
  <table width="954" id="options">
    <tr>
      <th width="171">Option</th>
      <th width="124">Values</th>
      <th width="87">Default</th>
      <th width="552">Description</th>
    </tr>
    <tr>
      <td>isRequired</td>
      <td>true or false</td>
      <td>true</td>
      <td>Determines whether any checkboxes need to be checked. Set to 'false' to bypass validation.</td>
    </tr>
    <tr>
      <td>maxSelections</td>
      <td>number</td>
      <td>null</td>
      <td>Determines the maximum number of checkboxes that can be checked within the checkbox group. </td>
    </tr>
    <tr>
      <td>minSelections</td>
      <td>number</td>
      <td>null</td>
      <td>Determines the minimum number of checkboxes that need to be checked before being valid.</td>
    </tr>
    <tr>
      <td>validateOn</td>
      <td>&quot;blur&quot;, &quot;change&quot;</td>
      <td>submit</td>
      <td>The widget always validates onSubmit. onBlur and onChange can be added with this option. Both can be applied with an array ['blur', 'change']</td>
    </tr>
  </table>
  <pre> &lt;script type=&quot;text/javascript&quot;&gt; 
   var ac1 = new Spry.Widget.ValidationCheckbox(&quot;myCollapsiblePanel&quot;,{isRequired:false, minSelections:2, maxSelections:5, validateOn:['blur','change']});   
 &lt;/script&gt;
</pre>
  <p>Recall that javascript is case sensitive. </p>
</div>
<div id="methods">
  <h2>Checkbox Validation Widget Methods</h2>
  <div id="reset">
    <h3><strong>reset</strong></h3>
    <p>Reset the widget to its original state.</p>
    <h4>Format</h4>
    <p>widgetName.reset();</p>
    <h4>Example</h4>
    <pre> &lt;a href=&quot;#&quot; onclick=&quot;checkbox1.reset(); return false;&quot;&gt;Reset Checkbox&lt;/a&gt; </pre>
  </div>
  <div id="validate">
    <h3><strong>validate</strong></h3>
    <p>Validates the current state of the widget.</p>
    <h4>Format</h4>
    <p>widgetName.validate();</p>
    <h4>Example</h4>
    <pre>&lt;a href=&quot;#&quot; onclick=&quot;checkbox1.validate(); return false;&quot;&gt;Validate Checkbox&lt;/a&gt;</pre>
  </div>
</div>
<hr /><p>Copyright © 2007. Adobe Systems Incorporated. <br />
All rights reserved.</p></body>
</html>
